/*
 * Copyright (C) 2000 - 2024 Silverpeas
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * As a special exception to the terms and conditions of version 3.0 of
 * the GPL, you may redistribute this Program in connection with Free/Libre
 * Open Source Software ("FLOSS") applications as described in Silverpeas's
 * FLOSS exception.  You should have received a copy of the text describing
 * the FLOSS exception, and it is also available here:
 * "https://www.silverpeas.org/legal/floss_exception.html"
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package org.silverpeas.core.security.token;

/**
 * A generator of tokens.
 *
 * A token isn't simply just an atom or a symbol. It has a type that is related to the way it is
 * used. Because the use of tokens differ, their value (the atom) cannot follow the same pattern and
 * therefore they have to be generated in the way that matches their use. It is why the tokens
 * differ by their type and each type of token has their own generator.
 *
 * As a generator is mapped with a token type, it is expected that such generator is indicated by
 * the annotation {@link org.silverpeas.core.security.token.annotation.TokenGenerator} with a token class
 * declaration.
 *
 * @author mmoquillon
 */
public interface TokenGenerator {

  /**
   * Generates a new token by taking into account any of the specified generation parameters.
   *
   * @param <T> the concrete type of the token to generate.
   * @param parameter the parameter of the token generation.
   * @return a new token.
   */
  <T extends Token> T generate(TokenGenerationParameter... parameter);

  /**
   * Renews the specified token. The token value will be regenerated.
   *
   * @param <T> the concrete type of the token to renew.
   * @param token the token to renew.
   * @return the renewed token.
   */
  <T extends Token> T renew(T token);
}
